Skip to main content

signercli -help

Help System and Command-Specific Documentation​

1. Overview​

The signercli command provides a built-in help system that allows users to:

  • View the list of available commands
  • Access detailed usage instructions for each command
  • Quickly understand command-specific options and workflows

The help system is designed to be self-discoverable, making it suitable for:

  • First-time users
  • Administrators
  • CI/CD automation engineers

2. Basic Help (Command List)​

Display General Help​

signercli -help

This command displays:

  • CLI version information
  • General usage syntax
  • A list of all available top-level commands
  • References to command-specific help topics

This is the default entry point to the signercli help system.

3. Command-Specific Help​

Each major command provides its own detailed help page, accessible via:

signercli -help <command>

These help pages describe:

  • Command purpose
  • Supported options and flags
  • Usage examples
  • Related commands

4. Login Help​

Display Login Help​

signercli -help login

Provides detailed guidance for:

  • User authentication
  • SSH key–based login
  • Token-based session handling
  • Optional parameters such as certificate chain inclusion

Typical use cases:

  • Interactive administrator login
  • Initial environment setup
  • Secure access configuration

5. Configuration Help​

Display Configuration Help​

signercli -help config

Describes how to:

  • View current configuration
  • Create and manage signing profiles
  • Set default server endpoints
  • Delete or update profiles

This help section is essential for:

  • Multi-environment setups
  • CI/CD profile management
  • Shared signing infrastructure

6. Signing Help​

Display Signing Help​

signercli -help sign

Explains:

  • File signing syntax
  • Supported file types (executables, documents, scripts)
  • Hash-only signing mode
  • Profile-based signing
  • Common signing options

This is the primary reference for day-to-day signing operations.

7. Additional Command Help Topics​

When running signercli -help without arguments, the CLI also lists available detailed help topics for individual commands.

Available Help Topics​

signercli -help login          Login command help
signercli -help sign           Signing command help
signercli -help verify         Signature verification help
signercli -help config         Configuration management help
signercli -help cert           Certificate management help
signercli -help codesign       Code signing certificate help
signercli -help install        DLL installation help
signercli -help privkey        API-based private key management help

Each help topic corresponds to a dedicated command reference, providing in-depth documentation for that specific function.

8. Help System Design Notes​

  • Help commands are non-destructive and can be safely executed at any time
  • Output format follows the same conventions as other CLI commands
  • The help system is consistent across platforms (Windows, Linux, macOS)

9. Summary​

The signercli help system offers:

  • A single-entry overview via signercli -help
  • Granular, command-specific documentation
  • Clear guidance for both interactive and automated use cases

It is recommended to consult the relevant -help <command> page before using advanced features such as certificate management, HSM integration, or API-based automation.